CRM360° CustomerApi Documentation

Customer - Address

Manage contact's address entities. An address entity is composed of postal address, email, mobile email, home phone and mobile phone.

Required HTTP Headers

  • X-Crm360Api-Token
  • X-Crm360Api-CustomerName
  • X-Crm360Api-DatabaseAlias

Functions

Entity Properties

Name Type Is Mandatory
AddressId Int32
ContactId Int32
Address1 String
Address2 String
Address3 String
Address4 String
Address5 String
Address6 String
Address7 String
PostCode String
City String
State String
CountryId String
AddressOptin Boolean
AddressAdvertiserCreationDate DateTime
AddressStateId Int32
Email String
EmailOptin Boolean
EmailAdvertiserCreationDate DateTime
EmailStateId Int32
HomePhoneNumber String
HomePhoneCountryId String
HomePhoneOptin Boolean
HomePhoneAdvertiserCreationDate DateTime
HomePhoneStateId Int32
MobilePhoneNumber String
MobilePhoneCountryId String
MobilePhoneOptin Boolean
MobilePhoneAdvertiserCreationDate DateTime
MobilePhoneStateId Int32
DeletionFlag Boolean
BrandId Int32
ContactAddressTypeId Int16
BrandIdString String
Brand Brand
ContactAddressType ContactAddressType
EmailState EmailState
HomePhoneState HomePhoneState
MobilePhoneState MobilePhoneState
PostalAddressState PostalAddressState
Contact Contact
PostalAddresseCountry Country
HomePhoneCountry Country
MobilePhoneCountry Country

Examples

Select all Addresses

https://customerapi.fts-crm360.com/data/Addresses()
HttpMethod : GET
Json Result :
[ { "AddressId" : "60", "ContactId" : "52", "Address1" : "lCv aJ4Txs", "Address2" : "vzXwM2BFiSWQvk8xNO", "Address3" : "a4LyohN B", "Address4" : "ulJ0D9dSCWBi", "Address5" : "0gPx dXqEc", "Address6" : "9iAtO9B k", "Address7" : "sLarmddJ2S2dVQZvN", "PostCode" : "iICfsjE ck", "City" : "i A CWTz", "State" : "gMJZfNvUdvmbbwLe2l", "CountryId" : "A4VfSUo", "AddressOptin" : "False", "AddressAdvertiserCreationDate" : "2007-09-09T00:00:00", "AddressStateId" : "36", "Email" : "5mjPhTiKkM", "EmailOptin" : "True", "EmailAdvertiserCreationDate" : "2002-06-29T00:00:00", "EmailStateId" : "34", "HomePhoneNumber" : "XFYQoietm99Ks1", "HomePhoneCountryId" : "14U8E0", "HomePhoneOptin" : "False", "HomePhoneAdvertiserCreationDate" : "2020-12-22T00:00:00", "HomePhoneStateId" : "19", "MobilePhoneNumber" : "37r 9To", "MobilePhoneCountryId" : "6OQCyy5M kQXlrFuTY", "MobilePhoneOptin" : "True", "MobilePhoneAdvertiserCreationDate" : "2002-08-12T00:00:00", "MobilePhoneStateId" : "77", "DeletionFlag" : "False", "BrandId" : "21", "ContactAddressTypeId" : "2", "BrandIdString" : "wmyso" }, { "AddressId" : "66", "ContactId" : "34", "Address1" : "z60l0hK", "Address2" : "oAS51RP", "Address3" : "Rp6WuGjAC AKG", "Address4" : "V66KxwQId1GE", "Address5" : "V5SLdX", "Address6" : "a9u9brW", "Address7" : "f CIqX9qedUH", "PostCode" : "EPo NFv", "City" : "iz4DXL8uEZblpWGB", "State" : "hUf934SxpuysIt", "CountryId" : "7LIDTL 7ZD2ghuH", "AddressOptin" : "False", "AddressAdvertiserCreationDate" : "2024-01-14T00:00:00", "AddressStateId" : "56", "Email" : "aTj5 wkhO6XQt", "EmailOptin" : "True", "EmailAdvertiserCreationDate" : "2014-04-03T00:00:00", "EmailStateId" : "40", "HomePhoneNumber" : "36WWTjj AxP6lLtkJW", "HomePhoneCountryId" : "YRISuox ByJs3UM", "HomePhoneOptin" : "True", "HomePhoneAdvertiserCreationDate" : "1996-10-28T00:00:00", "HomePhoneStateId" : "21", "MobilePhoneNumber" : "Hv E Ul", "MobilePhoneCountryId" : "upric9 ovnmsgi", "MobilePhoneOptin" : "False", "MobilePhoneAdvertiserCreationDate" : "1995-08-06T00:00:00", "MobilePhoneStateId" : "85", "DeletionFlag" : "True", "BrandId" : "37", "ContactAddressTypeId" : "6", "BrandIdString" : "dpX8N6YLJSZ" }, ... ]

Select Address by Id

https://customerapi.fts-crm360.com/data/Addresses(60)
HttpMethod : GET
Json Result :
{ "AddressId" : "5", "ContactId" : "15", "Address1" : "XGlO4Ti9a", "Address2" : "elLbDH58 OQ U", "Address3" : "PCnblUNpYRJ5P", "Address4" : "cR0eOxcnu6HAYaB5", "Address5" : "x 1rGYFX0", "Address6" : "5RJ3EetY", "Address7" : "wiImTrTj7xmcQxHP", "PostCode" : "mluGHZn p9IS6ThP", "City" : "N2Xi yzIkNvpfA", "State" : "O3HppoIgMdBVao", "CountryId" : "T6AK4YdCk6S9zZpKJ", "AddressOptin" : "False", "AddressAdvertiserCreationDate" : "2009-12-04T00:00:00", "AddressStateId" : "7", "Email" : "K2k9D", "EmailOptin" : "False", "EmailAdvertiserCreationDate" : "1999-08-25T00:00:00", "EmailStateId" : "7", "HomePhoneNumber" : "cYfu5 nUHPw0iuXpVGi", "HomePhoneCountryId" : "3Z6kyHCaL", "HomePhoneOptin" : "True", "HomePhoneAdvertiserCreationDate" : "1996-02-24T00:00:00", "HomePhoneStateId" : "32", "MobilePhoneNumber" : "md5dDe0h QSMnINUuO", "MobilePhoneCountryId" : "vECc57xwMHSMb1", "MobilePhoneOptin" : "True", "MobilePhoneAdvertiserCreationDate" : "2002-06-14T00:00:00", "MobilePhoneStateId" : "46", "DeletionFlag" : "False", "BrandId" : "26", "ContactAddressTypeId" : "6", "BrandIdString" : "xCkpRke5N2EztOh" }

Create a Address

https://customerapi.fts-crm360.com/data/Addresses()
HttpMethod : POST
Json Post :
{
"ContactId" : "42",
"Address1" : "jHsDUrgC1Ws",
"Address2" : "vIdm39AdynWS19QNZt",
"Address3" : "Z0 mH4obXCl Ny",
"Address4" : "culL",
"Address5" : "f6p7w NW",
"Address6" : "TpIuTCvgWsP",
"Address7" : "p LMHf fgmM4",
"PostCode" : "34VqWe E7v",
"City" : "Red9sMPdkt0fcuo5Z04",
"State" : "bOX J 1 N btqP5",
"CountryId" : "A1yUWuUoCY26tj",
"AddressOptin" : "True",
"AddressAdvertiserCreationDate" : "2002-03-02T00:00:00",
"AddressStateId" : "5",
"Email" : "eCGCz",
"EmailOptin" : "True",
"EmailAdvertiserCreationDate" : "2005-02-10T00:00:00",
"EmailStateId" : "26",
"HomePhoneNumber" : "wRH0M  4",
"HomePhoneCountryId" : "CjVt5tXxh6Qpy",
"HomePhoneOptin" : "True",
"HomePhoneAdvertiserCreationDate" : "2014-10-11T00:00:00",
"HomePhoneStateId" : "62",
"MobilePhoneNumber" : "2g8Bf9FcjX5hqGuq",
"MobilePhoneCountryId" : "MdswHZrBv  m",
"MobilePhoneOptin" : "True",
"MobilePhoneAdvertiserCreationDate" : "1997-05-15T00:00:00",
"MobilePhoneStateId" : "45",
"DeletionFlag" : "False",
"BrandId" : "44",
"ContactAddressTypeId" : "9",
"BrandIdString" : "6ehlPQWWbO2"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Update a Address

https://customerapi.fts-crm360.com/data/Addresses(60)
HttpMethod : PUT
Json Post :
{
"AddressId" : "81",
"ContactId" : "54",
"Address1" : "T M5 uHR vjF1lSdUNJ",
"Address2" : "u p2cfxB",
"Address3" : "z3lcnoEP",
"Address4" : "bNUpeyBIZ",
"Address5" : "D94opQPUVUbe8EBL",
"Address6" : "8oO8MNAx76De10TGA9",
"Address7" : "4O7LXUu5",
"PostCode" : "7PPnT6DfKy1v22sVL",
"City" : "edHY6GwRn c1ndTL",
"State" : "raL6wz6OHgBXO1L",
"CountryId" : "OasjUI1ASDBT",
"AddressOptin" : "True",
"AddressAdvertiserCreationDate" : "2006-02-04T00:00:00",
"AddressStateId" : "44",
"Email" : "BAovpjsUbr9PPQw",
"EmailOptin" : "True",
"EmailAdvertiserCreationDate" : "2014-11-21T00:00:00",
"EmailStateId" : "15",
"HomePhoneNumber" : "2dPWijKn",
"HomePhoneCountryId" : "wnDvDVUNMa qtYH",
"HomePhoneOptin" : "False",
"HomePhoneAdvertiserCreationDate" : "1999-08-13T00:00:00",
"HomePhoneStateId" : "61",
"MobilePhoneNumber" : "ASan IjNxpFKd6 i",
"MobilePhoneCountryId" : "nOK57iZPUjIEHtY8Z",
"MobilePhoneOptin" : "True",
"MobilePhoneAdvertiserCreationDate" : "2007-03-30T00:00:00",
"MobilePhoneStateId" : "34",
"DeletionFlag" : "False",
"BrandId" : "7",
"ContactAddressTypeId" : "6",
"BrandIdString" : "HhiFPVut0T 6"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Patch a Address

https://customerapi.fts-crm360.com/data/Addresses(60)
HttpMethod : PATCH
Json Post :
{
"EmailAdvertiserCreationDate" : "2007-10-06T00:00:00",
"AddressOptin" : "True",
"MobilePhoneAdvertiserCreationDate" : "1997-04-22T00:00:00",
"HomePhoneCountryId" : "AYrk Hp6sNEUkM i",
"Address1" : "qxZ T 9 aO tcg",
"MobilePhoneCountryId" : "grTmXAE 3mZBQ",
"ContactId" : "41",
"AddressStateId" : "14",
"Address5" : "ebSwDqutZtv 4",
"BrandId" : "22"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a Address

https://customerapi.fts-crm360.com/data/Addresses(60)
HttpMethod : DELETE